home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / toes114g.arc / TOES.DOC < prev    next >
Text File  |  1991-05-21  |  45KB  |  1,005 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.    ████████████████   ████████████████   ████████████████   ████████████████
  12.           ██          ██            ██   ██                 ██            ██
  13.           ██          ██            ██   ██                 ██
  14.           ██          ██            ██   ██                 ██
  15.           ██          ██            ██   ██████████         ████████████████
  16.           ██          ██            ██   ██                               ██
  17.           ██ Telix    ██    OPUS    ██   ██   Express            Script   ██
  18.           ██          ██            ██   ██                 ██            ██
  19.           ██          ████████████████   ████████████████   ████████████████
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                           ┌───────────────────────────┐
  29.                           │ ver *- 1.14 -*  May 1991  │
  30.                           └───────────────────────────┘
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                    Originally written by Ken Ironside of 5:491/1
  37.  
  38.                  Currently maintained by Allan Marillier of 5:491/1
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.     I N D E X
  47.     ---------
  48.  
  49.             CHRONOLOGICAL RECORD ..................................   1
  50.  
  51.             INTRODUCTION ..........................................   1
  52.  
  53.             DISCLAIMER ............................................   2
  54.  
  55.             FILES DISTRIBUTED IN THE TOES PACKAGE .................   2
  56.  
  57.             UPGRADING FROM PREVIOUS VERSIONS OF THE SCRIPT ........   2
  58.  
  59.             COMPILING THE SCRIPT FILES IN PREPARATION FOR USE .....   3
  60.  
  61.             CUSTOMISING THE BATCH FILES ...........................   3
  62.  
  63.             CONFIGURATION .........................................   4
  64.  
  65.                  Telix ............................................   4
  66.  
  67.                  Opus .............................................   4
  68.  
  69.                  Silver Express on the BBS side ...................   4
  70.  
  71.                  TOES .............................................   5
  72.  
  73.             USING TOES ............................................   6
  74.  
  75.             USING TOES_CFG ........................................   8
  76.  
  77.             USING TOESREQ .........................................   9
  78.  
  79.             GENERAL PROBLEMS - QUESTIONS AND ANSWERS ..............  11
  80.  
  81.             ACKNOWLEDGEMENTS ......................................  12
  82.  
  83.             DETAILED BUG/ENHANCEMENT HISTORY ......................  12-17
  84.  
  85.  
  86.                                                        TOES v 1.14 - Page 1
  87.  
  88.  
  89.     CHRONOLOGICAL RECORD
  90.     --------------------
  91.     Version 1    - Ken Ironside, July 1990.                 TELIX_SE.ZIP.
  92.     Version 1.11 - Allan Marillier, September/October 1990. TSF111AM.ZIP.
  93.     Version 1.12 - Allan Marillier, January 1991.           TSF112AM.ZIP.
  94.     Version 1.13 - Allan Marillier, January 1991.           TSF113AM.ZIP.
  95.     Version 1.14 - Allan Marillier, April 1991.             TOES114.ZIP.
  96.  
  97.  
  98.     INTRODUCTION
  99.     ------------
  100.     Toes is a script written in SALT (Script Application Language for
  101.     Telix). The script came about as a result of Dave Pedler, SYSOP of the
  102.     Golden City OPUS, at 5:491/1 introducing the use of Silver Express on
  103.     his BBS. A need was seen to automate the process of connecting to the
  104.     BBS, proceeding to the Silver Express menu, uploading an existing reply
  105.     mail packet, and downloading a new mail packet.
  106.  
  107.     The original script was written by Ken Ironside of 5:491/1, and was
  108.     named SXP.
  109.  
  110.     During the course of the development of the script, numerous changes
  111.     have taken place, many changes have been made, bugs fixed, and plans
  112.     for enhancements put into action. The script has also undergone a few
  113.     name changes.
  114.  
  115.     Originally known as SXP, the package consisted of three files, SXP.SLT,
  116.     LOGON.SLT and a brief manual named READ.ME. These were distributed in
  117.     .ZIP form, as a file named TELIX_SE.ZIP.
  118.  
  119.     The script name remained unchanged, but the .ZIP file name was later
  120.     changed to TSFxxxAM.ZIP, to indicate :
  121.     Telix Silver Express Fido, version numbers (from 111 to 113) and AM
  122.     being the initials of the person releasing the new version.
  123.  
  124.     As the file naming convention was not entirely accurate, it has now
  125.     been changed to TOESxxx.ZIP - which indicates Telix OPUS Express
  126.     Script. The version numbers will remain unchanged, to indicate the
  127.     logical progression of the script. The names of the scripts themselves
  128.     have also changed, and a number of supporting files have been added.
  129.  
  130.     While this script (and related files) have been specifically written
  131.     for OPUS, anyone with sufficient time, and inclination could easily
  132.     modify it to work with any other BBS. Note also that while this script
  133.     is OPUS specific, it is also dependent on which front-end is used on
  134.     the BBS and any other programs used by the SYSOP of the OPUS BBS.
  135.  
  136.     Please be aware, that you are receiving RAW source code. It MUST be
  137.     compiled before it can be used. Contrary to the normal order of events,
  138.     when receiving a pre-compiled program and you immediately run the
  139.     program to configure it, you must FIRST compile all source files,
  140.     and THEN configure TOES before use. Please read the section COMPILING
  141.     THE SCRIPT FILES IN PREPARATION FOR USE before attempting to use any
  142.     part of the TOES package.
  143.  
  144.  
  145.                                                        TOES v 1.14 - Page 2
  146.  
  147.  
  148.     DISCLAIMER
  149.     ----------
  150.     These files have been tested fairly thoroughly, in my environment, as
  151.     well as on a few tester's systems. They work for me. There is no
  152.     guarantee that they will work for you. However - any problems, bug
  153.     reports, and requests for changes will be catered for - time and
  154.     resources permitting.
  155.  
  156.  
  157.     FILES DISTRIBUTED IN THE TOES PACKAGE
  158.     -------------------------------------
  159.     TOES consists of the files as listed below. Please note that only
  160.     uncompiled .SLT script files are distributed - it is expected that you
  161.     the user compile the scripts yourself, enabling you to make any minor
  162.     changes as necessary, without the need to download a new copy of the
  163.     package in order to fix simple bugs.
  164.  
  165.     TOESMAKE BAT   - a simple batch file to compile the scripts
  166.     TOESRUN  BAT   - a simple batch file to activate TOES via Telix
  167.                      using the supplied Telix config file, which has
  168.                      the status line turned off
  169.     TOESDGET BAT   - a batch file used to activate DSZ for download
  170.     TOESDSND BAT   - a batch file used to activate DSZ for upload
  171.     TOESPGET BAT   - a batch file used to activate PCZ for download
  172.     TOESPSND BAT   - a batch file used to activate PCZ for upload
  173.     TOES     DOC   - this manual
  174.     TOES     SLT   - the main TOES script (source code)
  175.     TOES_CFG SLT   - the TOES configuration program (source code)
  176.     TOESDIAL SLT   - the TOES logon script (source code)
  177.     TOESREQ  SLT   - the TOES request file generator (source code)
  178.     PR       BAT   - replacement general use download batch file for PCZ
  179.     PS       BAT   - replacement general use upload batch file for PCZ
  180.  
  181.  
  182.     UPGRADING FROM PREVIOUS VERSIONS OF THE SCRIPT
  183.     ----------------------------------------------
  184.     Previous versions of the script, known as SXP, had a total of five
  185.     files :
  186.       SXP.SLT, SXP.SLC, LOGON.SLT, LOGON.SLC, READ.ME
  187.     These files should be copied to a backup location, just as a
  188.     precaution, after which they should be deleted.
  189.  
  190.     The file TOES.ZIP should be copied to a backup location, then
  191.     "unzipped" into your Telix directory.
  192.  
  193.     Please note that in previous versions of the script, you were required
  194.     to make certain changes to both files SXP.SLT, and LOGON.SLT before
  195.     compiling. This is no longer necessary. Please read the section
  196.     TOES CONFIGURATION below.
  197.  
  198.  
  199.                                                        TOES v 1.14 - Page 3
  200.  
  201.  
  202.     COMPILING THE SCRIPT FILES IN PREPARATION FOR USE
  203.     -------------------------------------------------
  204.     This version of the script assumes the use of Telix v 3.12, 3.15 or
  205.     greater. Note that earlier versions of Telix will not support some of
  206.     the functions used in the script. Some bugs evident in v 3.12 have been
  207.     fixed in v 3.15 - which may make some small differences to the script.
  208.     The most notable of these is the frename() function - used in making a
  209.     backup copy of the mail packet if required. Under v 3.12 the function
  210.     would rename the mail packet to the current directory, and NOT to the
  211.     one specified. This is apparently fixed in v 3.15.
  212.  
  213.     As all script files are distributed in source code form, they need to
  214.     be compiled before use. A batch file named TOESMAKE.BAT is provided to
  215.     do this for you, but you can compile each of the four scripts manually
  216.     if you prefer.
  217.  
  218.       CS TOES     <Enter>
  219.       CS TOES_CFG <Enter>
  220.       CS TOESDIAL <Enter>
  221.       CS TOESREQ  <Enter>
  222.  
  223.     After this, provided you have copied the original source files to a
  224.     backup location, the four .SLT files as well as TOESMAKE.BAT may be
  225.     deleted to conserve disk space.
  226.  
  227.  
  228.     CUSTOMISING THE BATCH FILES
  229.     ---------------------------
  230.     The batch files named TOESDGET.BAT, TOESDSND.BAT, TOESPGET.BAT and
  231.     TOESPSND.BAT will very likely require some modification. They are used
  232.     by TOES if you require the use of an external Zmodem protocol, for
  233.     whatever reason. I have configured them to work on my system, but they
  234.     may need some changes depending on the speed you lock your comms port
  235.     at, and on which comms port you are using. The batch files named
  236.     TOESD??? are for use with DSZ, while those named TOESP??? are for use
  237.     with PCZ. I assume the use of DSZ, or PCZ, but for that matter, any
  238.     other external Zmodem protocol may be used. In this case it is up to
  239.     you the user, to read the relevant manuals, and replace the DSZ / PCZ
  240.     syntax with whatever is required by the program of your choice.
  241.  
  242.     You may also need to change the path and file names of the mail and
  243.     reply packets if they are different from the way I've configured it. I
  244.     find it logical to store all my Silver Express files in a directory
  245.     named XPRESS, with my mail directory as \XPRESS\MAIL, and reply
  246.     directory as \XPRESS\REPLY.
  247.  
  248.     As for external Zmodem programs, my personal recommendation is to use
  249.     PCZ rather than DSZ, as it appears to be more flexible, and is a little
  250.     faster in returning control to the script than Telix' internal Zmodem.
  251.  
  252.  
  253.                                                        TOES v 1.14 - Page 4
  254.  
  255.     CONFIGURATION
  256.     -------------
  257.  
  258.     Telix
  259.     -----
  260.     Telix can be left in it's normal configuration as you prefer to use it.
  261.     Any configuration options that specifically need to be changed will be
  262.     done so automatically by the script at run time.
  263.  
  264.     The one setting that is required though, is in your Telix dialling
  265.     directory. It is expected that you will have already configured your
  266.     dialling directory with the relevant telephone numbers, BBS names,
  267.     passwords, modem speeds etc. The only extra requirement for TOES, is
  268.     that you configure Telix to use the script TOESDIAL as the script to be
  269.     run after connection.
  270.  
  271.     Press Alt D, <Enter> to display your dialling directory. Point to the
  272.     directory entry to be changed, press E. Fill in all details as
  273.     necessary, making the entry "Linked Script" TOESDIAL.
  274.  
  275.     Note that you will usually also have placed your password in the
  276.     dialling directory entry. The script will read a password from the
  277.     configuration file, and if so configured will use that password in
  278.     place of the one in the Telix dialling directory. This requirement came
  279.     about from a user whose password is longer than that allowed in the
  280.     Telix dialling directory - which has some merit.
  281.  
  282.     If you intend using Telix's internal Zmodem protocol, you must also set
  283.     Automatic Zmodem downloads on. This is done by pressing Alt-O, T, N and
  284.     selecting "On".
  285.  
  286.     Remember to save the configurations of both your dialling directory and
  287.     the Telix configuration.
  288.  
  289.  
  290.     Opus
  291.     ----
  292.     You must select the Zmodem file transfer protocol as the default.
  293.     Set your Configuration as follows:
  294.  
  295.     Help........REGULAR          Nulls.......0
  296.     scrn.Width..80               scrn.Length 24          Tabs........NO
  297.     More?.......NO               Video mode..TTY
  298.     IBM Chars...YES
  299.  
  300.     Please take special note of the More option - it is important.
  301.  
  302.  
  303.     Silver Express on the BBS side
  304.     ------------------------------
  305.     Set Zmodem as the default file transfer protocol.
  306.     Set the following parameters as indicated:
  307.  
  308.     [G].........Graphics Mode.             - OFF
  309.     [M].........Menu Hot Keys.             - OFF
  310.     [X].........Expertise Level.           - EXPERT
  311.  
  312.  
  313.                                                        TOES v 1.14 - Page 5
  314.  
  315.  
  316.     TOES
  317.     ----
  318.     Remember, all the script files must first be compiled before they will
  319.     be capable of running.
  320.  
  321.     TOES will check for a file named TOES.CNF in the directory from which
  322.     it is activated. If it is missing, it will automatically execute the
  323.     script TOES_CFG in order to create one, and allow you to customise it.
  324.     This will then be saved for future use.
  325.  
  326.     A list of user configurations is shown below, with default settings.
  327.     Once you have made your changes, those will be recorded for future use.
  328.     Please note that the file TOES.CNF is in Ascii format, and you CAN
  329.     change it with any editor you like, but be very careful to keep
  330.     uppercase throughout, and not to change any ordering, or write any
  331.     strange characters to the file. Unpredictable results may occur.
  332.     To build in complex error checking is not worth the effort, and you
  333.     assume responsibility for any problems caused by "fiddling:.
  334.  
  335.  
  336.        A: Colour Display                      : No
  337.        B: Dialing Directory Entries           : 1 2
  338.        C: User Name (as defined to BBS)       : Jan Pierewiet
  339.        D: Mail File Name                      : GCOBBS.OPX
  340.        E: Reply File Name                     : GCOBBS.REP
  341.        F: Mail Directory                      : C:\XPRESS\MAIL\
  342.        G: Reply Directory                     : C:\XPRESS\REPLY\
  343.        H: Date Named Backup                   : No
  344.        I: Z-Modem - Internal, Dsz, Pcz        : Internal
  345.        J: Automatically Destroy Existing .OPX : No
  346.        K: Read TOES Config file for password  : No
  347.        L: BBS Password                        : Choose_a_password:-50_chars
  348.  
  349.        W: Exit and save changes to disk.
  350.        X: Exit without saving changes.
  351.  
  352.  
  353.     Any options not correct may be changed. Please also be aware that no
  354.     error checking is done to prevent irresponsible setting of
  355.     configurations. If you want to be silly and use an alias - that's your
  356.     business. Likewise - if you enter dialling directory numbers other than
  357.     real, valid ones - the script will not work correctly.
  358.  
  359.     Mail and reply directories MUST have the trailing \ on the path. Lucky
  360.     you - if you don't put it in, the script will do it for you.
  361.  
  362.     These options will be described in more detail in the section on
  363.     running the TOES_CFG script.
  364.  
  365.  
  366.                                                        TOES v 1.14 - Page 6
  367.  
  368.  
  369.     USING TOES
  370.     ----------
  371.     Remember, the script TOES must first be compiled before it will be
  372.     capable of running.
  373.  
  374.     TOES is a very complex script, which automates a number of tasks for
  375.     you. As with any script being run by Telix, it may be invoked from the
  376.     command line :
  377.  
  378.                    TELIX STOES
  379.  
  380.     from the batch file TOESRUN.BAT (please edit/check that your directory
  381.     path for Telix is consistent with the batch file's), or from within
  382.     Telix, by pressing Alt G, and then typing the name TOES.
  383.  
  384.     Once execution starts TOES will initialize itself, and check for a
  385.     configuration file named TOES.CNF. This contains certain information
  386.     needed by TOES and TOESDIAL to connect you to the BBS, and perform your
  387.     file transfers, placing the files in the correct directories.
  388.  
  389.     If the file is missing, TOES_CFG will be invoked, after which control
  390.     returns to TOES for further processing. (Note that you may also run
  391.     TOES_CFG independently of TOES).
  392.  
  393.     TOES will pause to ask if a delayed start to polling is required. You
  394.     also have the option at this point to abort execution of the script. If
  395.     no response is received within twenty seconds, TOES will proceed to
  396.     attempt a connection. If you choose to delay the start, TOES will
  397.     display the current date and time, then prompt you for the time at
  398.     which polling should begin. The time is validated, and must take the
  399.     form HH:MM. These can be any values from 00:00 through to 23:59. If a
  400.     time given is BEFORE the current time, it will be interpreted to mean
  401.     start polling at that time the following day. As an example - it may
  402.     now be 15:17. I want polling to start tomorrow morning at 04:00. I
  403.     simply set the start time to be 04:00.
  404.  
  405.     In an effort to save your screen from burn-in, (you could turn it off,
  406.     or turn the brightness down) - TOES will clear the screen, and display
  407.     a moving character to indicate that it is still executing. There is
  408.     just one problem - the Telix status line cannot be cleared like this.
  409.     If you want to use this facility, I suggest you create a second Telix
  410.     configuration file, with Status Line set OFF. Activate Telix with that
  411.     configuration file.
  412.  
  413.     If at any time during the delay you choose to abort, or proceed
  414.     immediately, press any key. You will be presented with a list of
  415.     options - Abort, Continue to delay, Proceed immediately. Your choice
  416.     will then be acted on. There is one minor problem with this - choosing
  417.     abort calls the Telix function exittelix(); which is supposed to abort
  418.     Telix, and return to DOS. For some reason this is not working properly,
  419.     and re-runs the script. Choosing another delayed time, and then
  420.     Aborting a second time works perfectly. This will be fixed as soon as
  421.     possible.
  422.  
  423.  
  424.  
  425.                                                        TOES v 1.14 - Page 7
  426.  
  427.  
  428.     If you have requested use of an external Zmodem protocol, TOES will
  429.     turn Zmodem auto file downloading off, to prevent Telix's internal
  430.     Zmodem from interfering and attempting a second file transfer. The
  431.     upload and download directories will be set to the mail and reply
  432.     directories as configured in TOES.CNF.
  433.  
  434.     A log file will be created, in which all activity will be recorded to
  435.     allow you to later check and see that all was well with the
  436.     connection. This log file is named according to the date in the form
  437.     YYMMDD.LOG. Note that only ONE log file is created per day. These may
  438.     be deleted immediately after viewing if necessary.
  439.  
  440.     A check is made to see if any reply packets exist, as well as to see if
  441.     any old mail packets are still in the mail directory. If Automatically
  442.     Destroy Existing .OPX has been set to YES, then the old file will be
  443.     deleted. If not, you will be prompted (for 60 seconds) whether to
  444.     ignore the file, make a backup copy, delete it, or abort the script.
  445.     If you don't respond within that time, a backup copy is automatically
  446.     made, and processing continues. Please be aware at this point, that the
  447.     frename function is used here. If using Telix 3.12, the backup copy
  448.     will be "moved" to your current directory. If using Telix 3.15, the
  449.     function is claimed to have been fixed, and the backup copy will be in
  450.     the correct mail directory.
  451.  
  452.     TOES will then cause Telix to dial the numbers as configured, until one
  453.     of them makes contact. At this point, provided you configured the
  454.     correct linked script in your Telix dialling directory, TOESDIAL will
  455.     take control, and log you in to the BBS, leaving you at the Bulletin
  456.     menu prompt.
  457.  
  458.     At one time, Dave chose to make use of a program named GOOSE, to force
  459.     password changes at frequent intervals, in the interests of security. I
  460.     made allowance for that by adding a facility to test for GOOSE
  461.     requesting a new password, and if required to read it from a file named
  462.     PASSWORD.NEW. The first line of the file would be read. The first word
  463.     would be taken as the new password, and the remainder treated as a
  464.     comment. The file would then be deleted, and a warning message written
  465.     to the log file to remind you to change your password in your dialling
  466.     directory. (See - the log file DOES have it's uses !) Dave no longer
  467.     uses GOOSE, but the facility is still intact, just in case.
  468.  
  469.     Control will now return to TOES.
  470.  
  471.     TOES will now proceed via the main menu to select the Express option.
  472.  
  473.     Once in Silver Express, TOES will initiate an upload, if a reply packet
  474.     exists. When complete, a download will be requested to determine
  475.     whether or not any new mail exists. If it does, a download will be
  476.     initiated.
  477.  
  478.     Note at this point, that TOES has a simple form of error recovery. If
  479.     an error is detected in a Telix internal Zmodem file transfer, TOES
  480.     will automatically retry the transfer using the batch files TOES?GET
  481.     and TOES?SND. No test is made to see if the external Zmodem program as
  482.     set in the batch files exists. This is your responsibility.
  483.  
  484.  
  485.  
  486.                                                        TOES v 1.14 - Page 8
  487.  
  488.  
  489.     If you have configured TOES.CNF to indicate that a date named backup is
  490.     required, a copy of the downloaded mail packet (if any) will be made to
  491.     a file with a name in the form YYMMDDnn.OPX. This file will reflect the
  492.     date, as well as the number of the connection. The first backup file
  493.     will be named YYMMDD00.OPX, the second YYMMDD01.OPX and so on.
  494.  
  495.     Please also remember at this point, that Telix's internal Zmodem has
  496.     some advantages, as well as potential dangers. If Zmodem crash recovery
  497.     is on, Telix will attempt to append new packets to any old ones. This
  498.     causes corrupt Silver Express .OPX data files. If Zmodem crash recovery
  499.     is off, Telix on seeing an existing .OPX file, will automatically
  500.     rename the NEW one to ?????.OPn, where n is the next available number.
  501.  
  502.     Once file transfers are complete, TOES will return from Telix to the
  503.     main menu on the BBS. At this point, Dave at one time, configured
  504.     OPUS/Silver Express to require the password to be re-entered. I added a
  505.     facility to test for the password being requested, and to submit it as
  506.     necessary. When Dave chose to remove that nice < :-( > feature, I left
  507.     the facility intact for possible future use.
  508.  
  509.     At this point, you will be returned to the OPUS main menu. TOES will
  510.     now test for the existence of a file named TOES.REQ. If it is found,
  511.     all embedded commands will be submitted to OPUS to allow configuration
  512.     changes, Statistics reports etc. as well as file uploads and downloads.
  513.     Note that as of 9 April 1991 this is still under testing and development.
  514.     After use, this file will be deleted. This also allows for access to
  515.     Silver Express to perform simlar tasks.
  516.  
  517.     Once processing is complete, TOES will log off the system properly, and
  518.     return you to the DOS prompt.
  519.  
  520.  
  521.  
  522.  
  523.     USING TOES_CFG
  524.     --------------
  525.     Remember, the script TOES_CFG must first be compiled before it will be
  526.     capable of creating the configuration file.
  527.  
  528.     TOES_CFG is a script used to create and edit the file TOES.CNF, used in
  529.     passing user configurations to TOES. All configs used to be defined as
  530.     variables within the script, but this was unwieldy, and insecure, in
  531.     that it required the user to modify the script sometimes. As with any
  532.     program, maintenance is best left to the programmers/maintainers. It
  533.     was also something of a nuisance, requiring the user to recompile
  534.     either SXP (now TOES) or LOGON (now TOESDIAL) whenever any changes were
  535.     made.
  536.  
  537.     TOES_CFG will be automatically invoked by TOES if the file TOES.CNF is
  538.     missing, but may also be run as a stand alone script. It will also be
  539.     useful for editing the user configurations. On being invoked, the
  540.     following screen is displayed :
  541.  
  542.  
  543.                                                        TOES v 1.14 - Page 9
  544.  
  545.  
  546.                      TOES Configuration Script
  547.  
  548.        A: Colour Display                      : No
  549.        B: Dialing Directory Entries           : 1 2
  550.        C: User Name (as defined to BBS)       : Jan Pierewiet
  551.        D: Mail File Name                      : GCOBBS.OPX
  552.        E: Reply File Name                     : GCOBBS.REP
  553.        F: Mail Directory                      : C:\XPRESS\MAIL\
  554.        G: Reply Directory                     : C:\XPRESS\REPLY\
  555.        H: Date Named Backup                   : No
  556.        I: Z-Modem - Internal, Dsz, Pcz        : Internal
  557.        J: Automatically Destroy Existing .OPX : No
  558.        K: Read TOES Config file for password  : No
  559.        L: BBS Password                        : Choose_a_password:-50_chars
  560.  
  561.        W: Exit and save changes to disk.
  562.        X: Exit without saving changes.
  563.  
  564.  
  565.     These options are all self explanatory, and will not be discussed any
  566.     further. Making any changes involves nothing more than selecting the
  567.     letter preceeding the required option and pressing Enter. In the case of
  568.     the four options with Yes or No facilities, only a Y or N may be
  569.     entered as a response. Other options take any input, including the
  570.     dialling directory entries. Be careful of this one. It must be a string
  571.     which reflects the dialling directories as you have configured them in
  572.     Telix. Any other unrecognised garbage will cause the script to hang,
  573.     attempting to get Telix to dial the incorrect entries.
  574.  
  575.  
  576.     USING TOESREQ
  577.     -------------
  578.     Remember, the script TOESREQ must first be compiled before it will be
  579.     capable of creating the request files.
  580.  
  581.     TOESREQ started out as a humble project, with an intention to create a
  582.     facility for users to simulate the OPUS and Silver Express menus, on
  583.     the BBS side, watch user keystrokes, and write them to file to be
  584.     automatically submitted by the script. This humble task turned into a
  585.     massive project, resulting in a script of over 2500 lines of source
  586.     code.
  587.  
  588.     This source code is distributed as part of the TOES package, to allow
  589.     you to customise it if necessary, but this should be done with great
  590.     caution.
  591.  
  592.     TOESREQ itself is basically self explanatory, but a short description
  593.     may be in order. It is expected that it will be run stand alone, with
  594.     the DOS command line TELIX STOESREQ.
  595.  
  596.     The script will then create an OPUS emulation, which will appear to
  597.     leave you at the main menu. From here - exiting is achieved by pressing
  598.     Esc, a message to this effect is also displayed.
  599.  
  600.     All menus now behave like OPUS menus, with some of the options even
  601.     displaying real output as captured from a live session. All keystrokes
  602.     are recorded to file for later processing.
  603.  
  604.  
  605.                                                       TOES v 1.14 - Page 10
  606.  
  607.  
  608.     Some of the menu options are not supported, and these will be indicated
  609.     by a message to that effect. Examples of these are reading on-line
  610.     help, requests to read messages on line, requests to do a Silver
  611.     Express message up/download etc. They are not supported because they
  612.     are already catered for by the use of Silver Express, or simply because
  613.     they are not considered necessary.
  614.  
  615.     Please note that the only exit point (as intended) is from the OPUS
  616.     main menu. This is so that upon completion of processing requests, the
  617.     script will be returned to a point from which it can log off the BBS
  618.     correctly. As soon as the TOES.REQ file has been processed by TOES, it
  619.     is deleted.
  620.  
  621.     Please also be aware of a few things. TOES and TOESREQ make quite a few
  622.     assumptions. It is not practical to test for every possible silly
  623.     mistake you may make, and between running TOESREQ, and TOES you may
  624.     make some changes yourself. If you choose to upload a file - ensure
  625.     that it really exists in the directory you have instructed TOES.REQ to
  626.     find it in. If you choose to download a file, ensure that it doesn't
  627.     already exist in the directory where it will be downloaded to. Zmodem
  628.     crash recovery is turned off by TOES at start of execution, to avoid
  629.     appending new Silver Express message (.OPX) files to old. It is NOT
  630.     turned back on again.
  631.  
  632.     Different Zmodem implementations will behave in different ways here -
  633.     Telix' internal Zmodem will create a new file, with an extension where
  634.     the last character is replaced by a number. eg TOES114G.ZI1 - instead
  635.     of .ZIP. DSZ though, will fail, with a message that a file exists and
  636.     may not be over-written. Remember also that unless you register your
  637.     copy of DSZ, it will dump the file in the CURRENT directory, and ignore
  638.     any path you may request. PCZ will download to a defined path, but I
  639.     can't find any mention in the manual of what will happen if a file
  640.     already exists when a download attempt is made. I also can't get PCZ to
  641.     work properly. :-(
  642.  
  643.  
  644.  
  645.                                                       TOES v 1.14 - Page 11
  646.  
  647.  
  648.     GENERAL PROBLEMS - QUESTIONS AND ANSWERS
  649.     ----------------------------------------
  650.  
  651.     DSZ - or any other external comms program behaves erratically, doesn't
  652.     initiate the file transfer ... waits with an error message :
  653.  
  654.  
  655.     o  Check your environment space. DSZ needs to find itself on the DOS
  656.        path, or to have enough free environment space to add itself to the
  657.        path.
  658.  
  659.     o  Check that you have the syntax of the program correct. DSZ
  660.        particularly, is case sensitive.
  661.  
  662.     o  Check that you have enough free memory to shell from Telix out
  663.        to the external program being used.
  664.  
  665.     o  If using DSZ with a US Robotics modem, check that you have
  666.        handshake both in your batch file, or numerous timeouts and other
  667.        funny errors may result.
  668.  
  669.     o  Files downloaded through the file TOES.REQ don't end up in the
  670.        expected directory - DSZ won't allow re-directing of a downloaded
  671.        file in an unregistered copy of the program. It will dump downloads
  672.        in the current directory.
  673.  
  674.  
  675.     TOES hanging, or getting stuck :
  676.  
  677.  
  678.     o  Check that prompts haven't changed, or that DSZ or any other
  679.        external programs actually are in the directory from which
  680.        TOES is run.
  681.  
  682.     o  Wait a litle while before assuming that TOES is stuck - returning
  683.        from a call to an external file transfer program such as DSZ or PCZ
  684.        can be a little slow, causing TOES timing to get out of synch with
  685.        that on the BBS. Twenty to thirty seconds may on (rare) occasions be
  686.        necessary.
  687.  
  688.  
  689.  
  690.                                                       TOES v 1.14 - Page 12
  691.  
  692.  
  693.     ACKNOWLEDGEMENTS
  694.     ----------------
  695.     No decent manual is complete without a list of acknowledgements -
  696.     Special thanks are due (in random, not favourite order) to :
  697.       Hector Santos for Silver Express
  698.       Colin Sampaleanu for Telix
  699.       Dave Pedler for making them available
  700.       Ken Ironside for creating the original script
  701.       Mimi Milstein for constantly testing, and bleating about problems, as
  702.         well as proof reading and paginating this manual
  703.       Tim Jackson for constantly testing, and bleating about problems
  704.       Pat Verner, Lester Hanger and others for criticisms and suggestions
  705.         (which will be implemented one day, if not already done !)
  706.  
  707.     Finally - no charge ever has been, or ever will be made for the use of
  708.     this package. Knowledge of the size of user base, and the level of
  709.     satisfaction is interesting - and I would appreciate knowing a few
  710.     details.
  711.  
  712.  
  713.     You may send me NetMail at 5:491/1, or post to
  714.     P.O. Box 6490
  715.     Westgate
  716.     1734
  717.  
  718.  
  719.     Please let me know who you are, where you got your copy of TOES, which
  720.     version you have, which BBS you use, and whether you have any problems,
  721.     and suggestions for improvements.
  722.  
  723.  
  724.                                                       TOES v 1.14 - Page 13
  725.  
  726.  
  727.     DETAILED BUG/ENHANCEMENT HISTORY
  728.     --------------------------------
  729.     /////////////////////////////////////////////////////////////////
  730.     September 1990
  731.     Modifications by Allan Marillier  :
  732.  
  733.     SXP.SLT
  734.  
  735.     1)  Modified it to check if a trailing backslash appears in the
  736.         path pointing to the upload / download directory, to allow the
  737.         script to correctly find the reply file. If a trailing backslash is
  738.         NOT present, it will be added, before the name of the reply file is
  739.         appended to the path. This in both functions, check_upload_dir and
  740.         check_dnload_dir
  741.  
  742.     2)  Function check_dnload_dir :
  743.         I fixed a typo - if the mail file (.OPX) was found, it prompted
  744.         to rename to .BAT, but actually renamed to .BAK.
  745.         There appears to be a bug in the SALT frename function - as
  746.         it renames the file, to the current directory, and NOT to the
  747.         configured download directory. This is not a serious problem.
  748.  
  749.     3)  I added to the menu to inform where the .BAK will be, when a .OPX
  750.         file exists.
  751.  
  752.     4)  I added a simple message to the effect that no .OPX file was
  753.         found to exist - mainly for info. - debugging
  754.  
  755.     5)  I added a constant variable to hold Ken's colour scheme - as
  756.         his calculated color was wrong, according to the comments -
  757.         presumably later modified for a mono screen.
  758.  
  759.     6)  I have added a global constant, user settable, for whether the
  760.         screen can show colour or not.
  761.  
  762.     7)  If a mail packet is found to exist, I cater for no user input - ie.
  763.         after 60 secs of no manual intervention, assume ignore, and
  764.         set crash recovery off, as Z modem will create another file
  765.         anyway. eg. .OPX will be followed by .OP0, .OP1 etc.
  766.  
  767.     8)  I added a test for OPUS's Select: prompt appearing due to instant
  768.         return from Silver Express, now that Dave has decided not to
  769.         request the password on returning.
  770.         BUT - the test for the password is still intact, so that if Dave
  771.         decides to enforce password entry, it's automatically catered for.
  772.  
  773.     9)  I added a line of code to delete the reply packet AFTER a successful
  774.         upload.
  775.  
  776.     10) I removed some code that displayed a message, and gave some sound
  777.         effects if too many messages are found when attempting to download.
  778.         This will be logged in the cap file anyway - and it is expected
  779.         that all users will check the cap file after a connection to verify
  780.         that all went well. This MAY be re-introduced as a possible
  781.         enhancement, to sound an alarm, open a window asking if the script
  782.         should be aborted to allow manual re-configuration etc. At the
  783.         moment, I see no need for it.
  784.  
  785.  
  786.                                                       TOES v 1.14 - Page 14
  787.  
  788.  
  789.     LOGON.SLT
  790.  
  791.     1) Added a few lines of code to send a second Enter to Golden
  792.        City, as Dave added the use of the YMS (Your Mail Sir) program,
  793.        subsequent to Ken's release of the script. This indicates the
  794.        presence or lack of messages in areas 1 and 3, then requires an
  795.        Enter. This caused the script to fail.
  796.  
  797.     2) Added some code to cater for Dave's use of the program GOOSE, which
  798.        requires password changes at pre-determined intervals. This code
  799.        will watch for a message requesting a password change. When
  800.        detected, it checks the CURRENT directory for a file named
  801.        PASSWORD.NEW. If found, a single read is performed to see if a
  802.        password can be found. The length of the password required by the
  803.        sysop must be set in the variable new_word_len. Dave currently
  804.        requires 6 characters. This may change in the future.
  805.        If no file is found, a message is written to the log file, and the
  806.        script aborts.
  807.  
  808.        If less than 6 characters are found, a message is written to the log
  809.        file, and the script aborts.
  810.  
  811.        If 6 or more characters are found, the word UP TO the first space
  812.        char is used. This word will then be passed to the BBS, once as a
  813.        new password and then again for the verification. An informational
  814.        message is written to the log file, the file PASSWORD.NEW is renamed
  815.        to PASSWORD.OLD, and the script proceeds as normal.
  816.        REMEMBER - the password must still be changed in the dialling
  817.        directory.
  818.  
  819.        Note that by checking for characters up to the first space found,
  820.        the balance of the line can be used as a comment. As an example, the
  821.        file PASSWORD.NEW could be created as follows :
  822.  
  823.         COPY CON PASSWORD.NEW <enter>
  824.         sample_password This is now treated as a comment : 26 September 1990
  825.         Ctrl Z <enter>
  826.  
  827.        What this achieves is that the new password will be sample_password.
  828.        The remainder of the line is ignored, and can be used to remind
  829.        yourself what the file is, and what it's for.
  830.  
  831.  
  832.     GENERAL
  833.  
  834.        I have made a lot of changes to the code itself - removed some code,
  835.        replaced some, and generally "tidied up" both my, and Ken's
  836.        programming styles.
  837.  
  838.        After uploading version 1.10, I found that I had deleted a few lines
  839.        which send a keystroke when first entering SE, when required to
  840.        press any key twice to enter. This (v 1.11) is a bug fix for that.
  841.  
  842.  
  843.                                                       TOES v 1.14 - Page 15
  844.  
  845.  
  846.    /////////////////////////////////////////////////////////////////
  847.     January 1991
  848.     Modifications by Allan Marillier
  849.  
  850.     SXP.SLT
  851.  
  852.     1) I added 2 new variables, and code to make Telix to upload and
  853.        download to the user's defined mail/reply directories
  854.  
  855.     2) I changed the log file to a YYMMDD.LOG format, Pat Verner's
  856.        suggestion
  857.  
  858.     3) I added a facility (user changeable by a variable) to make
  859.        a copy of the .OPX file, immediately after download, with
  860.        the name in the format YYMMDDnn.OPX
  861.  
  862.     4) I discovered, and fixed a bug in a previous addition - to check
  863.        for trailing backslashes in the up and download directory names
  864.        This is caused by a bug in SALT's substr function.
  865.  
  866.  
  867.     /////////////////////////////////////////////////////////////////
  868.     End of January 1991
  869.     Modifications by Allan Marillier
  870.  
  871.     SXP.SLT
  872.  
  873.     1)  Dave is now using a NEW version of Express on his side.
  874.         There is a new item in the menu S, which stopped the script
  875.         from seeing that the menu was waiting for input.
  876.  
  877.     2)  The prompt to download files has changed in the BBS side of SX
  878.  
  879.     3)  The prompt to upload files has changed in the BBS side of SX
  880.  
  881.     4)  I added code to check for not enough memory when attempting
  882.         to make a backup copy of the mail packet, and advise
  883.         accordingly, in the log file
  884.  
  885.  
  886.     /////////////////////////////////////////////////////////////////
  887.     End of February 1991
  888.     Modifications by Allan Marillier
  889.  
  890.     SXP.SLT
  891.  
  892.     1)  I added code to check for a file named OPUS.REQ, which should
  893.         contain valid instructions to OPUS, and send the codes until
  894.         end of file. eg. F (file menu), A (area change), 1, T (type),
  895.         F491-001.NEW (new files list), Q (quit to main menu)
  896.         This will automatically be captured to the log file.
  897.  
  898.  
  899.  
  900.                                                       TOES v 1.14 - Page 16
  901.  
  902.  
  903.     /////////////////////////////////////////////////////////////////
  904.     April 1991
  905.     Modifications by Allan Marillier
  906.  
  907.     SXP.SLT - now known as TOES.SLT
  908.  
  909.     From the last release until now, I have been working on the utility
  910.     script, TOES_REQ.SLT, which emulates the OPUS and Silver Express
  911.     screens, to create the files OPUS.REQ and XPRESS.REQ, which will be
  912.     used by the script to automate almost any function available on the BBS.
  913.  
  914.     1)  I fixed a bug that was causing date named copies to be created
  915.         only for sessions 0, and 1. 1 kept being overwritten with new.
  916.  
  917.     2)  I added a facility to choose to use an external Zmodem protocol,
  918.         or internal Zmodem.
  919.  
  920.     3)  I renamed the script from TSFxxxAM to TOESxxx
  921.  
  922.     4)  I shortened the delay required by the waitfor("Successful Transfer
  923.         after uploading from 3600 to 15 seconds. This caused a problem
  924.         with DSZ. Problem is, DSZ still doesn't return to the script
  925.         quick enough, so I can only check for Successful Transfer
  926.         if internal Zmodem is used. With DSZ we have to take a chance
  927.         and assume that if it returns to the script, then it was OK.
  928.  
  929.     5)  I added a new variable to allow auto deletion of old OPXs, or
  930.         to allow prompting before deletion. Note that with DSZ it is
  931.         necessary to get rid of old OPXs even if auto zap is not set.
  932.         To do this, if DSZ is set, and an old OPX is found, then it
  933.         is renamed (which will then appear in the current directory,
  934.         because of bugs in the frename function). Note that under Telix
  935.         v 3.15 the bug in this function has been fixed.
  936.  
  937.     6)  I added code to test for successful up/downloads using Telix'
  938.         internal ZModem. In event of aborted transfer, the script will
  939.         immediately try again using an external protocol - eg. DSZ or PCZ
  940.         if either is present, using the supplied batch files, TOES?SND and
  941.         TOES?GET. If the carrier signal is lost, the script writes a
  942.         message to the log file, and exits gracefully
  943.  
  944.     7)  I added code to read configurations from a file named TOES.CNF. A
  945.         complimentary script file, TOES_CFG is used to create/edit the
  946.         configuration. This eliminates the need for a user to make any
  947.         changes to the main TOES script, or to recompile it each time any
  948.         configuration changes are made.
  949.  
  950.     8)  Total rewrite of the manual.
  951.  
  952.     9)  I changed the scripts so that no more user customisation is
  953.         necessary for config changes. That is all done via a config file.
  954.  
  955.    10)  I added a facility to delay start of polling the BBS for up to 24
  956.         hours, with a screen save facility built in.
  957.  
  958.    11)  I added a facility to choose Abort, Continue delay, or Proceed
  959.         immediately to the delayed connect facility
  960.  
  961.  
  962.                                                       TOES v 1.14 - Page 17
  963.  
  964.  
  965.    12)  I added sample batch files for use with both PCZ and DSZ. They can
  966.         be easily copied to TOES?SND.BAT and TOES?GET.BAT. I also added a
  967.         Telix config file, to turn the status line off, for use with the
  968.         delayed connect screen save facility.
  969.  
  970.    13)  I fixed a few minor bugs in the TOES_CFG configuration script.
  971.  
  972.    14)  I built in a test for more than one page of news in Silver Express
  973.         on the BBS side. If the "More" prompt appears, this should be
  974.         handled correctly.
  975.  
  976.    15)  I added an option to the prompt, whether delayed start of polling
  977.         is required or not. You may now also enter an A to abort the script.
  978.  
  979.    16)  I changed the configuration again - you may choose from Internal
  980.         Zmodem, Dsz or Pcz. It is not necessary to copy batch files around,
  981.         just to keep the 4 main ones TOESDGET, TOESDSND, TOESPGET and
  982.         TOESPSND. These will be called directly by the script if you select
  983.         an external protocol.
  984.  
  985.    17)  I changed the configuration to optionally allow sending the password
  986.         as stored in the config file, and not the Telix dialling directory.
  987.         This is specifically to suit users whose password is longer than
  988.         that allowed in the dialling directory entry.
  989.  
  990.    18)  I modified the code to test for file transfer failure (within
  991.         Silver Express), search for PCZ, and use that if found, else to
  992.         search for DSZ and use that if found.
  993.  
  994.    19)  I added code to write $FINISHED$ at the end of the TOES.REQ file, as
  995.         the end of file test wasn't working properly.
  996.  
  997.    20)  I fixed problems with TOES doing the uploads, and downloads, using
  998.         both Internal Zmodem, as well as DSZ and PCZ.
  999.  
  1000.    21)  I added code to make TOES reset the upload and download directories
  1001.         to the way they're configured in Telix, so that downloaded files
  1002.         will appear where they're expected to.
  1003.  
  1004.  
  1005.